feat: Lighter styling on internal irefs #5071
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Documents like https://datatracker.ietf.org/doc/html/draft-ietf-ohai-ohttp-06 use a tagging scheme for certain keywords that turns them into links. This can be useful in giving people the ability to quickly jump to the definition of an important term, but it tends to produce a lot of visual noise. The resulting links are blue and underlined, which can be distracting when there are lots of these links. This change removes styling for these links. If there is an `<iref>` tag (which renders as an empty `<span>`) immediately preceding a link and that link is tagged `class="internal"`, link styling is removed. These will still result in the cursor changing to a pointer, but the blue and underlining will reduce line noise. Note that this change depends on a corresponding change in kramdown-rfc that reorders the generation of the iref and xref tags. The above document will not change in appearance as a result, because that version of kramdown-rfc generated the tags in the wrong order. A new version generated with an updated kramdown-rfc is forthcoming.
martinthomson
added a commit
to martinthomson/xml2rfc
that referenced
this pull request
Feb 2, 2023
See ietf-tools/datatracker#5071 for context. This removes the blue coloration from internal links that immediately follow an `<iref>` tag (rendered as a `span.iref`). This reduces visual noise arising from the use of keyword linking. See https://github.com/cabo/kramdown-rfc/wiki/Syntax2#index-entries for details on how that operates.
|
I'm pretty sure that the test failure here isn't due to this change. |
larseggert
approved these changes
Feb 2, 2023
rjsparks
approved these changes
Feb 2, 2023
kesara
pushed a commit
to ietf-tools/xml2rfc
that referenced
this pull request
Feb 6, 2023
See ietf-tools/datatracker#5071 for context. This removes the blue coloration from internal links that immediately follow an `<iref>` tag (rendered as a `span.iref`). This reduces visual noise arising from the use of keyword linking. See https://github.com/cabo/kramdown-rfc/wiki/Syntax2#index-entries for details on how that operates.
kesara
pushed a commit
to kesara/datatracker
that referenced
this pull request
Feb 7, 2023
Documents like https://datatracker.ietf.org/doc/html/draft-ietf-ohai-ohttp-06 use a tagging scheme for certain keywords that turns them into links. This can be useful in giving people the ability to quickly jump to the definition of an important term, but it tends to produce a lot of visual noise. The resulting links are blue and underlined, which can be distracting when there are lots of these links. This change removes styling for these links. If there is an `<iref>` tag (which renders as an empty `<span>`) immediately preceding a link and that link is tagged `class="internal"`, link styling is removed. These will still result in the cursor changing to a pointer, but the blue and underlining will reduce line noise. Note that this change depends on a corresponding change in kramdown-rfc that reorders the generation of the iref and xref tags. The above document will not change in appearance as a result, because that version of kramdown-rfc generated the tags in the wrong order. A new version generated with an updated kramdown-rfc is forthcoming.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documents like
https://datatracker.ietf.org/doc/html/draft-ietf-ohai-ohttp-06 use a tagging scheme for certain keywords that turns them into links. This can be useful in giving people the ability to quickly jump to the definition of an important term, but it tends to produce a lot of visual noise. The resulting links are blue and underlined, which can be distracting when there are lots of these links.
This change removes styling for these links. If there is an
<iref>tag (which renders as an empty<span>) immediately preceding a link and that link is taggedclass="internal", link styling is removed. These will still result in the cursor changing to a pointer, but the blue and underlining will reduce line noise.Note that this change depends on a corresponding change in kramdown-rfc that reorders the generation of the iref and xref tags. The above document will not change in appearance as a result, because that version of kramdown-rfc generated the tags in the wrong order. A new version generated with an updated kramdown-rfc is forthcoming.